Add support for Laravel-style relations #167

bennothommo · 2024-02-19T08:30:42Z

This PR allows people to define Laravel-style relations using methods that return Relation objects. So instead of:

public $belongsTo = [
     'user' => User::class,
];

You may use:

public function user(): BelongsTo
{
    return $this->belongsTo(User::class);
}

The main reason for this is to reduce friction for porting Laravel code over to Winter, and as a preference point for people who may wish to use the more declarative style of defining relations.

I've adjusted the unit tests to demonstrate this in action, and will be porting over the relation tests in the Winter system module into Storm, as they really should be in Storm anyway.

In order to maintain parity with the array-style configuration of relations in Winter, method-defined relations will need to either implement one of the following to indicate that they provide relations, and allow certain functionality to find them as required (for example, deleting related models when deleting a primary model):

The relation method must have a return type that correlates to a Relation class (like with the example above)
Alternatively, the method must use the Winter\Storm\Database\Attributes\Relation attribute and define the relation type, like so:

use Winter\Storm\Database\Attributes\Relation;

#[Relation('belongsTo')]
public function user()
{
    return $this->belongsTo(User::class);
}

Todo

Fix attachment relations and tests
Add support for model traits with new format
Finish porting tests from Database Tester plugin in core
Full documentation of new syntax

We shouldn't test completely third-party code.

We no longer extend this class, and it doesn't seem to provide any functionality anyway.

This method is strictly a relationship method and should be grouped with the other relationship methods.

In order to maintain some semblance of parity with Laravel, we'll now use Laravel's relation constructors and simply overwrite the "new" relation methods to create Winter's relation instances. Winter's relation name and defined constraints functionality will now be called in our own handler after the relation has been instantiated. This will allow us to review the relation directly before any Winter code runs.

This allows people using the relation method format to define the "delete" attribute available to relation definition arrays.

…methods

The "validateRelationArgs" method does a whole lot of nothing - the most it does is enforce required parameters. These can be picked up in Laravel anyway.

Added the ability to define the field name and use this as a constraint for attachment relations, separating it from the relation name.

The "Test" suffix might inadvertently be picked up by PHPUnit as a test case.

…relations

src/Database/Traits/SoftDelete.php

LukeTowers

Still have performance issues with the softdelete trait

Instead of extending the Relation class, we will make the soft delete methods available immediately to the relations. However, you can only *enable* soft delete if the related model uses the soft delete trait, thereby ensuring the correct soft delete functionality is available to the model when required.

bennothommo · 2024-09-02T06:09:40Z

@LukeTowers I've changed the soft delete methods on the relation to be available at all times, but the actual soft delete flag will only be enabled when softDeletable() is called on the relation AND the related model has the SoftDelete trait.

src/Database/Dongle.php

src/Html/Helper.php

LukeTowers · 2024-09-26T18:46:30Z

@bennothommo is there a related docs PR?

bennothommo · 2024-09-27T02:32:23Z

@LukeTowers yep, here: wintercms/docs#176

…rove performance To prevent a particular infinite loop, we need to define the Relation type when using the Relation attribute for a method so that we don't have to instantiate the relation in order to find out what type it is.

bennothommo · 2024-10-08T00:52:04Z

Late change: Using the Relation attribute to define a relation method will now require the relation type to be defined as the attribute's first parameter. Only a minor API change, but critical for behind-the-scenes to prevent infinite loops.

So instead of:

#[Relation]

It would now be:

#[Relation('hasOne')]

When a relation is defined in both the relation properties and as a method with the same name, an exception will be thrown.

src/Database/Concerns/HasRelationships.php

WIP Laravel style relations

cbaa2e5

bennothommo added Status: In Progress Type: Enhancement labels Feb 19, 2024

bennothommo added 27 commits February 19, 2024 22:27

Discard filesystem test case.

8412881

We shouldn't test completely third-party code.

Add BelongsToMany, HasMany and HasOne tests

f2c68ce

Remove unneeded relation class.

49949fa

We no longer extend this class, and it doesn't seem to provide any functionality anyway.

Add HasManyThrough, HasOneThrough, MorphMany and MorphOne tests

80a853a

Move performDeleteOnRelations method into HasRelationship concern

a79bbb4

This method is strictly a relationship method and should be grouped with the other relationship methods.

Add ability to define relations (through methods) as dependent.

55f03dc

This allows people using the relation method format to define the "delete" attribute available to relation definition arrays.

Fix Stan issue

e8e093a

Add array schema for relations, add custom return types for relation …

583051b

…methods

Fix relation name for attachments

173c752

Allow dependent model to be marked as not dependent

39453b1

Shore up API, strengthen types, remove validation method

ce5ddf0

The "validateRelationArgs" method does a whole lot of nothing - the most it does is enforce required parameters. These can be picked up in Laravel anyway.

Minor

8594a13

Add ability to define model as pushable, add all relation definitions

7fd53cd

Add ability to define detachable relations

426a2d4

Add attachment tests

cd3e791

Fix attachment relations

ee17333

Added the ability to define the field name and use this as a constraint for attachment relations, separating it from the relation name.

Copilot went a bit hog-wild on that one

8a2d88e

Fix Stan issue

c9414e1

Rename MigratesForTest class

b93e935

The "Test" suffix might inadvertently be picked up by PHPUnit as a test case.

Move Sortable trait tests

d4c1191

Merge remote-tracking branch 'origin/develop' into wip/laravel-style-…

3ac262d

…relations

Add extension support for relations, add support for SoftDelete trait

bdc3849

Merge branch 'develop' into wip/laravel-style-relations

a84b1a2

Bring in all remaining tests from core

19b3f1a

Fix soft deletion

a2b12e5

Add soft delete tests specifically with Laravel relations

06f7b69

LukeTowers approved these changes Aug 16, 2024

View reviewed changes

LukeTowers reviewed Aug 16, 2024

View reviewed changes

src/Database/Traits/SoftDelete.php Outdated Show resolved Hide resolved

LukeTowers requested changes Aug 16, 2024

View reviewed changes

bennothommo added 2 commits September 2, 2024 14:01

Stan fixes

267187b

LukeTowers reviewed Sep 26, 2024

View reviewed changes

src/Database/Dongle.php Outdated Show resolved Hide resolved

LukeTowers reviewed Sep 26, 2024

View reviewed changes

src/Html/Helper.php Outdated Show resolved Hide resolved

LukeTowers approved these changes Sep 26, 2024

View reviewed changes

bennothommo added 5 commits October 7, 2024 01:55

Merge branch 'develop' into wip/laravel-style-relations

fe2fdec

Add support for dynamic Laravel-style relations through Extension

eb815a9

Stan fix

f8ee9d7

Stan fix

bbddb54

bennothommo added 4 commits October 8, 2024 01:14

Allow relation flags to be toggled

9867c26

Minor

13e66cf

Detect relation conflicts

55603fc

When a relation is defined in both the relation properties and as a method with the same name, an exception will be thrown.

Fix code smell

0775c36

LukeTowers reviewed Oct 8, 2024

View reviewed changes

src/Database/Concerns/HasRelationships.php Outdated Show resolved Hide resolved

LukeTowers modified the milestones: 1.3.0, 1.2.7 Oct 8, 2024

bennothommo added 2 commits October 8, 2024 05:01

Use SystemException rather than ApplicationException

98a2247

Fix tests

7a875c8

LukeTowers added Status: Completed and removed Status: Review Needed labels Oct 9, 2024

LukeTowers merged commit 4a62533 into develop Oct 9, 2024
10 checks passed

LukeTowers deleted the wip/laravel-style-relations branch October 9, 2024 06:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Laravel-style relations #167

Add support for Laravel-style relations #167

bennothommo commented Feb 19, 2024 •

edited

Loading

LukeTowers left a comment

bennothommo commented Sep 2, 2024

LukeTowers commented Sep 26, 2024

bennothommo commented Sep 27, 2024

bennothommo commented Oct 8, 2024 •

edited

Loading

Add support for Laravel-style relations #167

Add support for Laravel-style relations #167

Conversation

bennothommo commented Feb 19, 2024 • edited Loading

Todo

LukeTowers left a comment

Choose a reason for hiding this comment

bennothommo commented Sep 2, 2024

LukeTowers commented Sep 26, 2024

bennothommo commented Sep 27, 2024

bennothommo commented Oct 8, 2024 • edited Loading

bennothommo commented Feb 19, 2024 •

edited

Loading

bennothommo commented Oct 8, 2024 •

edited

Loading